Remove auto-commit API report workflow #8808
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
update-api-reports.yml
would runyarn build
and generate API reports (the md files incommon/api-review
that we use to check if the API surface has changed) in case the contributor forgot to (it would be run if the contributor runsyarn build
locally after making any changes but sometimes people forget).It also commits the changes to the remote branch, which causes some friction because
Switched it to the way the docs check works, which is to fail and log a message to run
yarn build
oryarn docgen:all
as is appropriate. (If there are differences found in both common/api-review and docs-devsite, then the suggestion is to runyarn docgen:all
as it covers both).Removed the final message step as the workflow log UI seems to direct you to look straight at the step that failed anyway. Put the messages in the failed step.
Tested api-report changes only and tested with docs changes only, and both seem to work.